From cdd84ddd7390cffdb485701d8d303c9ae59ae0a6 Mon Sep 17 00:00:00 2001 From: robertl Date: Thu, 11 Nov 2010 03:34:55 +0000 Subject: [PATCH] Add doc for miniHomer. --- gpsbabel/xmldoc/formats/miniHomer.xml | 62 +++++++++++++++++++ .../xmldoc/formats/options/miniHomer-Bar.xml | 20 ++++++ .../xmldoc/formats/options/miniHomer-Boat.xml | 20 ++++++ .../xmldoc/formats/options/miniHomer-Car.xml | 20 ++++++ .../formats/options/miniHomer-Heart.xml | 20 ++++++ .../xmldoc/formats/options/miniHomer-Home.xml | 20 ++++++ .../xmldoc/formats/options/miniHomer-baud.xml | 8 +++ .../formats/options/miniHomer-dump-file.xml | 6 ++ .../formats/options/miniHomer-erase.xml | 4 ++ .../options/miniHomer-first-sector.xml | 15 +++++ .../formats/options/miniHomer-initbaud.xml | 13 ++++ .../formats/options/miniHomer-last-sector.xml | 5 ++ .../formats/options/miniHomer-no-output.xml | 2 + .../options/miniHomer-read-at-once.xml | 7 +++ 14 files changed, 222 insertions(+) create mode 100644 gpsbabel/xmldoc/formats/miniHomer.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-Bar.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-Boat.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-Car.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-Heart.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-Home.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-baud.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-dump-file.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-erase.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-first-sector.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-initbaud.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-last-sector.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-no-output.xml create mode 100644 gpsbabel/xmldoc/formats/options/miniHomer-read-at-once.xml diff --git a/gpsbabel/xmldoc/formats/miniHomer.xml b/gpsbabel/xmldoc/formats/miniHomer.xml new file mode 100644 index 000000000..609888d77 --- /dev/null +++ b/gpsbabel/xmldoc/formats/miniHomer.xml @@ -0,0 +1,62 @@ + +Serial download protocol for GPS data loggers called "miniHomer". +These loggers are based on Skytraq Venus 5 and Venus 6 chipsets, but with modified firmware. +The miniHomer logger has five POI (or better: Point-to-Return, PTR?), which can be set programatically. The miniHomer module in gpsbabel is an extension of the skytraq module. + + + +Following a list of devices which should be supported by this module +(Note that not all of them have actually been tested, so if you can confirm that additional models work, please mail the gpsbabel-misc group with your success, tips, and any pertinent links for your model.) + + + +Devices supported by miniHomer module + + + + Manufacturer + Model + USB (baud) + Bluetooth (baud) + + + + + + Navin + Z:NEX + + miniHomer + up to 230400 + this device does not have bluetooth + + + +
+ + + Command showing miniHomer download of tracks and erasing the logger on Linux + gpsbabel -i miniHomer,erase -f /dev/ttyUSB0 -o gpx -F out.gpx + + + + Command showing miniHomer erasing the logger without download on Linux + gpsbabel -i miniHomer,erase,no-output -f /dev/ttyUSB0 + + +miniHomer has five POI called Home, Car, Boat, Heart, Bar. You can set the lla +(Lattitude, Longitude, Altitude) for each of the POI. The format is +<name>=<lat>:<lng>[:<alt>] +Once the according POI symbol is selected on miniHomer, the display shows you the direction and distance to the POI. + + + Command showing miniHomer setting Car and Home POI + + + gpsbabel -i miniHomer,Car=36.790145:-6.352898,Home=-3.066667:37.359167:5895 -f /dev/ttyUSB0 -o gpx -F out.gpx + + Sets the Car/Home symbols' latitude longitude and altitude. + If you select the Car/Home symbol on miniHomer, the display will show the direction and distance to + this location as soon as it has a satellite fix. + + diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-Bar.xml b/gpsbabel/xmldoc/formats/options/miniHomer-Bar.xml new file mode 100644 index 000000000..67151f40d --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-Bar.xml @@ -0,0 +1,20 @@ + + The device provides a location finder display supporting five locations "Home", "Car", "Boat", "Heart", "Bar". + You can program the location of each either by a keypress on the device (which uses the actual position) + or with GPSBabel (which lets you use any position) + You can set the location of "Bar" with the 'Bar' option. Use ':' as the delimiter between latitude, longitude and altitude. + You can leave altitude out, in which case it is assumed to be zero. + Note that GPSBabel terminates after writing the location info to the device, i.e. no logging data will be read from it. + + + Set the target location of the miniHomer Bar POI + + gpsbabel -i miniHomer,Bar=38.99809:-86.34662 -f /dev/ttyUSB0 -o unicsv -F - + + + Sets the Bar symbols' latitude to 38.99809N longitude to 86.34662W and altitude to 0m. + If you select the Bar symbol on miniHomer, the display will show the direction and distance to + this location as soon as it has a satellite fix. + + + diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-Boat.xml b/gpsbabel/xmldoc/formats/options/miniHomer-Boat.xml new file mode 100644 index 000000000..ba5cbc5b4 --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-Boat.xml @@ -0,0 +1,20 @@ + + The device provides a location finder display supporting five locations "Home", "Car", "Boat", "Heart", "Bar". + You can program the location of each either by a keypress on the device (which uses the actual position) + or with GPSBabel (which lets you use any position) + You can set the location of "Boat" with the 'Boat' option. Use ':' as the delimiter between latitude, longitude and altitude. + You can leave altitude out, in which case it is assumed to be zero. + Note that GPSBabel terminates after writing the location info to the device, i.e. no logging data will be read from it. + + + Set the target location of the miniHomer Boat POI + + gpsbabel -i miniHomer,Boat=32.29287:-64.77527 -f /dev/ttyUSB0 -o unicsv -F - + + + Sets the Boat symbols' latitude to 32.29287N longitude to 64.77527E and altitude to 0m. + If you select the Home symbol on miniHomer, the display will show the direction and distance to + this location as soon as it has a satellite fix. + + + diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-Car.xml b/gpsbabel/xmldoc/formats/options/miniHomer-Car.xml new file mode 100644 index 000000000..10d8f8868 --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-Car.xml @@ -0,0 +1,20 @@ + + The device provides a location finder display supporting five locations "Home", "Car", "Boat", "Heart", "Bar". + You can program the location of each either by a keypress on the device (which uses the actual position) + or with GPSBabel (which lets you use any position) + You can set the location of "Car" with the 'Car' option. Use ':' as the delimiter between latitude, longitude and altitude. + You can leave altitude out, in which case it is assumed to be zero. + Note that GPSBabel terminates after writing the location info to the device, i.e. no logging data will be read from it. + + + Set the target location of the miniHomer Car POI + + gpsbabel -i miniHomer,Car=-25.272309:153.235330 -f /dev/ttyUSB0 -o unicsv -F - + + + Sets the Car symbols' latitude to 25.272309S longitude to 153.235330E and altitude to 0m. + If you select the Car symbol on miniHomer, the display will show the direction and distance to + this location as soon as it has a satellite fix. + + + diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-Heart.xml b/gpsbabel/xmldoc/formats/options/miniHomer-Heart.xml new file mode 100644 index 000000000..9bed7327f --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-Heart.xml @@ -0,0 +1,20 @@ + + The device provides a location finder display supporting five locations "Home", "Car", "Boat", "Heart", "Bar". + You can program the location of each either by a keypress on the device (which uses the actual position) + or with GPSBabel (which lets you use any position) + You can set the location of "Heart" with the 'Heart' option. Use ':' as the delimiter between latitude, longitude and altitude. + You can leave altitude out, in which case it is assumed to be zero. + Note that GPSBabel terminates after writing the location info to the device, i.e. no logging data will be read from it. + + + Set the target location of the miniHomer Heart POI + + gpsbabel -i miniHomer,Heart=36.1269:-115.1698 -f /dev/ttyUSB0 -o unicsv -F - + + + Sets the Heart symbols' latitude to 36.1269N longitude to 115.1698W and altitude to 0m. + If you select the Heart symbol on miniHomer, the display will show the direction and distance to + this location as soon as it has a satellite fix. + + + diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-Home.xml b/gpsbabel/xmldoc/formats/options/miniHomer-Home.xml new file mode 100644 index 000000000..ada385885 --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-Home.xml @@ -0,0 +1,20 @@ + + The device provides a location finder display supporting five locations "Home", "Car", "Boat", "Heart", "Bar". + You can program the location of each either by a keypress on the device (which uses the actual position) + or with GPSBabel (which lets you use any position) + You can set the location of "Home" with the 'Home' option. Use ':' as the delimiter between latitude, longitude and altitude. + You can leave altitude out, in which case it is assumed to be zero. + Note that GPSBabel terminates after writing the location info to the device, i.e. no logging data will be read from it. + + + Set the target location of the miniHomer Home POI + + gpsbabel -i miniHomer,Home=-3.066667:37.359167:5895 -f /dev/ttyUSB0 -o unicsv -F - + + + Sets the Home symbols' latitude to 3.066667S longitude to 37.359167E and altitude to 5895m. + If you select the Home symbol on miniHomer, the display will show the direction and distance to + this location as soon as it has a satellite fix. + + + diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-baud.xml b/gpsbabel/xmldoc/formats/options/miniHomer-baud.xml new file mode 100644 index 000000000..bc17c6c09 --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-baud.xml @@ -0,0 +1,8 @@ +The following baud rates can be used: 4800, 9600, 19200, 38400, 57600, 115200, 230400. +Note that your logger might not support all of them (especially 230400 which isn't documented +in the chipset manual, though there are known devices that are capable of this speed). + + +If baud=0 (zero) download takes place at the baud rate the +device is currently set to. This is especially useful for Bluetooth connections (if available) since they +often don't allow changing the baud rate. diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-dump-file.xml b/gpsbabel/xmldoc/formats/options/miniHomer-dump-file.xml new file mode 100644 index 000000000..824b64672 --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-dump-file.xml @@ -0,0 +1,6 @@ + +This function is identical to the dump-file function of skytraq module: +Writes raw data as it is read from the logger to the file given as this option's argument +(additional to decoding it as usual). The resulting binary files can be read and decoded by the skytraq-bin format. +Mainly useful for debugging/development purposes. + diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-erase.xml b/gpsbabel/xmldoc/formats/options/miniHomer-erase.xml new file mode 100644 index 000000000..7921eb515 --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-erase.xml @@ -0,0 +1,4 @@ + +Erase log buffer. + + diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-first-sector.xml b/gpsbabel/xmldoc/formats/options/miniHomer-first-sector.xml new file mode 100644 index 000000000..1802768cf --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-first-sector.xml @@ -0,0 +1,15 @@ + +This function is identical to the first-sector function of skytraq module. + +The logger's memory is organized in sectors, serially numbered starting at 0. Each sector takes 4096 bytes of data. +Typical devices hold about 250 sectors. The memory is always filled from sector 0 on, until it is full or the device being +erased again by the user. + +Normally you can safely omit this option. However, it might be useful to read data from erased devices: we observed +that on erase, only the first two sectors are actually cleared. The following example shows how to read the remaining data: + + + + Command showing how to read data from an erased device + gpsbabel -i miniHomer,first-sector=2 -f /dev/ttyUSB0 -o gpx -F out.gpx + diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-initbaud.xml b/gpsbabel/xmldoc/formats/options/miniHomer-initbaud.xml new file mode 100644 index 000000000..0edfdee58 --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-initbaud.xml @@ -0,0 +1,13 @@ + +This function is identical to the init-baud file function of skytraq module. + +The "initbaud" option might be helpful if autodetection fails or takes too long. With this option you +can tell GPSBabel the baud rate the device is currently set to. In contrast, the option "baud" specifies +the rate at which the actual download should take place. If it is different than "initbaud" (or the autodetected +rate, if initbaud wasn't given), the initial setting will be restored after finishing the download. + + +Please note that miniHomer by default uses 38400bps and does not autodetect the port speed. If you need autodetect, start as +gpsbabel -i miniHomer,initibaud=0 -f /dev/ttyUSB0 -o gpx -F out.gpx + + diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-last-sector.xml b/gpsbabel/xmldoc/formats/options/miniHomer-last-sector.xml new file mode 100644 index 000000000..836f46e23 --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-last-sector.xml @@ -0,0 +1,5 @@ +A value of -1 (the default) enables automatic mode, i.e. reading is stopped when an empty sector is +encountered. +We observed that sometimes the device doesn't report the correct number of used sectors, which confuses the Windows +software, so that it might not get all trackpoints. +In contrast, our algorithm ensures that everything is being read (please report if it doesn't work for you). diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-no-output.xml b/gpsbabel/xmldoc/formats/options/miniHomer-no-output.xml new file mode 100644 index 000000000..482aa8c17 --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-no-output.xml @@ -0,0 +1,2 @@ +If this option is given, no GPS log data will be read from the device +(unless "dump-file" is given too; in that case only decoding will be disabled). diff --git a/gpsbabel/xmldoc/formats/options/miniHomer-read-at-once.xml b/gpsbabel/xmldoc/formats/options/miniHomer-read-at-once.xml new file mode 100644 index 000000000..7283235cb --- /dev/null +++ b/gpsbabel/xmldoc/formats/options/miniHomer-read-at-once.xml @@ -0,0 +1,7 @@ +If read-at-once >= 1, batch mode is enabled with that many sectors being read at a time. +A value of zero disables batch mode and switches to single read mode. Not all devices support batch mode; in that case +gpsbabel automatically switches to single read mode. + +Under normal circumstances, the larger this number the faster the transfer. +Reducing read-at-once or even switching to single sector mode might help when you get +transmission errors/aborts. -- 2.30.2